.TH stoker.conf 5 "5 September 2008" "version 0.91" "Stoker Manual"
.SH NAME
stoker.conf \- Stoker configuration file
.SH DESCRIPTION
The main Stoker configuration file --
.I stoker.conf
-- is a file in scf2(5) format
that centrally configures stoker(8) and its components.
Upon startup, Stoker first looks for a file named
.I stoker.conf
in the current working directory.
If this file does not exist, Stoker next tries to read
.I $HOME/.stoker/stoker.conf
(where $HOME refers to the user's home directory).
Finally, if no per-user configuration exists, Stoker tries to use
the system-wide configuration file
.I /etc/stoker.conf
.SH GENERAL DIRECTIVES
.TP
.B machine_file = <path>
Specify the path to the local machine source configuration file.
See stoker_local(5) for more information.
.TP
.B use_ldap = <true | false>
Enable or disable the LDAP machine source.
See stoker_ldap(5) for more configuration details.
.TP
.B use_mysql = <true | false>
Enable or disable the MySQL machine source.
See stoker_mysql(5) for more configuration details.
.TP
.B maximum_concurrent_threads = <n>
When executing in parallel mode, limit the number of concurrent threads to
<n> (default: 16).
This directive can be overridden by using the \-t switch on the command line.
See stoker(8).
.TP
.B ssh_command = <command>
Use <command> as an SSH client, instead of ssh(1).
The syntax of the command to be used MUST be compatible with that of ssh(1).
.TP
.B scp_command = <command>
Use <command> as a secure copy client, instead of scp(1).
The syntax of the command to be used MUST be compatible with that of scp(1).
.SH WAKE ON LAN
.TP
.B wol_broadcast_address = <address>
Broadcast address to use with the Stoker wake command (stoker_wake(8)).
Default: 127.0.0.255
.TP
.B wol_delay = <seconds>
Wait <seconds> seconds between machines when using Wake-On-Lan (e.g. to avoid
tripping circuit breakers).
This setting is only effective when stoker(8) is in sequential mode.
Default: 0
.TP
.B wol_port = <port>
Destination port number to use with Wake-On-Lan.
Default: 9
.TP
.B wol_tries = <n>
Send the Wake-On-Lan "magic packet" <n> times.
Default: 1
.SH SEE ALSO
scf2(5), stoker(8), stoker_ldap(5), stoker_local(5), stoker_mysql(5),
stoker_wake(8), scp(1), ssh(1)
.SH AUTHOR
Mike Murphy (mamurph@cs.clemson.edu)
.SH DISCLAIMER
This material is based upon work supported under a National Science
Foundation Graduate Research Fellowship.
Any opinions, findings, conclusions or recommendations expressed in this
publication are those of the author(s) and do not necessarily reflect the
views of the National Science Foundation.
